<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Simple Module <i>BaseMobility</i></h2>
<b>Package:</b> org.mixim.base.modules<br/><b>File: <a href="base-modules-BaseMobility.ned.html">base/modules/BaseMobility.ned</a></b><br/><p><a href="../doxy/a00026.html" target="mainframe"><b>C++ definition</b></a></p>

<p>Module which is responsible for mobility
related information like position and movement
<a href="org.mixim.base.modules.BaseMobility.html">BaseMobility</a> itself defines a static mobility
pattern (means only a position, no movement).
Mobility modules which extend from this module
will define more complex movement patterns.</p>
<img src="org.mixim.base.modules.BaseMobility-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="org.mixim.base.modules.BaseMobility.html" title="BaseMobility" alt="BaseMobility" coords="0,0,128,40">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram. Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseMobility-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="org.mixim.base.modules.BaseMobility.html" title="Simple Module BaseMobility" alt="" coords="425,83,521,111">
<area shape="rect" id="node2" href="org.mixim.base.modules.BaseObject.html" title="Compound Module BaseObject" alt="" coords="5,6,96,34">
<area shape="rect" id="node4" href="org.mixim.modules.node.Host802154_2400MHz.html" title="Compound Module Host802154_2400MHz" alt="" coords="120,6,275,34">
<area shape="rect" id="node6" href="org.mixim.modules.node.Host802154A.html" title="Compound Module Host802154A" alt="" coords="299,6,400,34">
<area shape="rect" id="node8" href="org.mixim.examples.multiConnectionManager.PhyMacHost.html" title="Compound Module PhyMacHost" alt="" coords="424,6,523,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram. Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseMobility-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="org.mixim.base.modules.BaseMobility.html" title="Simple Module BaseMobility" alt="" coords="651,83,747,111">
<area shape="rect" id="node4" href="org.mixim.modules.mobility.ANSimMobility.html" title="Simple Module ANSimMobility" alt="" coords="5,161,115,189">
<area shape="rect" id="node6" href="org.mixim.modules.mobility.BonnMotionMobility.html" title="Simple Module BonnMotionMobility" alt="" coords="139,161,275,189">
<area shape="rect" id="node8" href="org.mixim.modules.mobility.CircleMobility.html" title="Simple Module CircleMobility" alt="" coords="299,161,400,189">
<area shape="rect" id="node10" href="org.mixim.modules.mobility.ConstSpeedMobility.html" title="Simple Module ConstSpeedMobility" alt="" coords="424,161,563,189">
<area shape="rect" id="node12" href="org.mixim.modules.mobility.LinearMobility.html" title="Simple Module LinearMobility" alt="" coords="587,161,688,189">
<area shape="rect" id="node14" href="org.mixim.modules.mobility.MassMobility.html" title="Simple Module MassMobility" alt="" coords="712,161,811,189">
<area shape="rect" id="node16" href="org.mixim.modules.mobility.MoBANLocal.html" title="Simple Module MoBANLocal" alt="" coords="835,161,933,189">
<area shape="rect" id="node18" href="org.mixim.modules.mobility.RectangleMobility.html" title="Simple Module RectangleMobility" alt="" coords="957,161,1083,189">
<area shape="rect" id="node20" href="org.mixim.modules.mobility.TractorMobility.html" title="Simple Module TractorMobility" alt="" coords="1107,161,1213,189">
<area shape="rect" id="node22" href="org.mixim.modules.mobility.TurtleMobility.html" title="Simple Module TurtleMobility" alt="" coords="1237,161,1336,189">
<area shape="rect" id="node2" href="org.mixim.base.modules.IBaseMobility.html" title="Module Interface IBaseMobility" alt="" coords="648,6,749,34">
</map>
<h3 class="subtitle">Known subclasses:</h3>
<table>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.ANSimMobility.html">ANSimMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Uses the &lt;position_change&gt; elements of the ANSim tool's
trace file.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.BonnMotionMobility.html">BonnMotionMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Uses the native file format of BonnMotion (http://www.cs.uni-bonn.de/IV/BonnMotion/).</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.CircleMobility.html">CircleMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Moves the node around a circle.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.ConstSpeedMobility.html">ConstSpeedMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Controls all movement related things of a host</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.LinearMobility.html">LinearMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>This is a linear mobility model with speed, angle and acceleration parameters.
Angle only changes when the mobile node hits a wall: then it reflects
off the wall at the same angle.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.MassMobility.html">MassMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>This is a random mobility model for a mobile host with a mass. It is the
one used in "Optimized Smooth Handoffs in Mobile IP" by Perkins &amp; Wang.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.MoBANLocal.html">MoBANLocal</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>This is the local mobility module of MoBAN. It should be instantiated in each node that belongs to a WBAN. The NED parameter "coordinatorIndex"
determine to which WBAN (<a href="org.mixim.modules.mobility.MoBANCoordinator.html">MoBANCoordinator</a>) it belongs.
The current implementation uses the Random Walk Mobility Model (RWMM) for individual (local) movement with a sphere around the node, with given speed
and sphere radius of the current posture. The reference point of the node it the current posture, the sphere radius, and the speed is given by the
corresponding coordinator through the blackboard. RWMM determines the location of node at ant time relative to the given reference point.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.RectangleMobility.html">RectangleMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Moves the node around a rectangle.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.TractorMobility.html">TractorMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Moves a tractor through a field with a certain amount of rows.
Since the tractor also moves around the field, the tractor travels
the number of rows PLUS one rows. Consider the following piece of
ascii-art for rows=2.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.mobility.TurtleMobility.html">TurtleMobility</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>A LOGO-style movement model, with the script coming from XML. It can be
useful for describing random as well as deterministic scenarios.</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Used in compound modules:</h3>
<p>If a module type shows up more than once, that means it has been defined in more than one NED file.</p>
<table>
<tr>
   <td>
      <a href="org.mixim.base.modules.BaseObject.html">BaseObject</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.node.Host802154_2400MHz.html">Host802154_2400MHz</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>

<p>This NED module defines a host using an IEEE 802.15.4 transceiver at 2.4GHz
for wireless communications, that can be used to simulate wireless sensor
networks. </p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.node.Host802154A.html">Host802154A</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>

<p>This host NED module models a host using an IEEE 802.15.4A correlation receiver.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.analogueModels.PhyMacHost.html">PhyMacHost</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.CSMAMac.PhyMacHost.html">PhyMacHost</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.ieee802154Narrow.PhyMacHost.html">PhyMacHost</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.multiConnectionManager.PhyMacHost.html">PhyMacHost</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr class="local">
   <td width="150">notAffectedByHostState</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120">true</td>
   <td>   </td>
</tr>
<tr class="local">
   <td width="150">coreDebug</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>debug switch for the core framework</p>
   </td>
</tr>
<tr class="local">
   <td width="150">x</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>x coordinate of the nodes' position (-1 = random)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">y</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>y coordinate of the nodes' position (-1 = random)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">z</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>z coordinate of the nodes' position (-1 = random)</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Properties:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
   </tr>
<tr>
   <td width="150">display</td>
   <td width="100"><i>i=block/cogwheel</i></td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">// Module which is responsible for mobility
// related information like position and movement
// BaseMobility itself defines a static mobility
// pattern (means only a position, no movement).
// Mobility modules which extend from this module
// will define more complex movement patterns.
</span><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseMobility</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">like</span><span style="color: #000000; "> </span><span style="color: #000000; ">IBaseMobility</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">notAffectedByHostState</span><span style="color: #000000; "> = </span><span style="color: #008000; ">true</span><span style="color: #000000; ">;
        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">coreDebug</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// debug switch for the core framework
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">x</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// x coordinate of the nodes' position (-1 = random)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">y</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// y coordinate of the nodes' position (-1 = random)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">z</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// z coordinate of the nodes' position (-1 = random)
</span><span style="color: #000000; ">        </span><span style="color: #000000; font-weight: bold; ">@display</span><span style="color: #000000; ">(</span><span style="color: #008000; ">&quot;i=block/cogwheel&quot;</span><span style="color: #000000; ">);
}

</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
